-
Notifications
You must be signed in to change notification settings - Fork 85
[transfers] Code generation: update services and models #1607
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Summary of ChangesHello @AdyenAutomationBot, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request delivers an automated update to the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces updates to the transfers service, primarily through auto-generated code from an OpenAPI specification. The changes include adding a new FundingInstrument model, updating various enums with new values, and improving documentation comments for several models.
The changes are consistent and reflect an API update. My review focuses on improving the clarity and completeness of the generated code, particularly the documentation, to enhance maintainability and ease of use for developers consuming this SDK. I've suggested adding missing JSDoc comments for new properties and clarifying the relationship between a deprecated enum value and its replacement.
|
|
||
|
|
||
| export class FundingInstrument { | ||
| "cardIdentification"?: CardIdentification | null; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider adding a JSDoc comment for the cardIdentification property to improve code clarity and maintainability. All other properties in this class have documentation.
| "cardIdentification"?: CardIdentification | null; | |
| /** | |
| * The card details of the funding instrument. | |
| */ | |
| "cardIdentification"?: CardIdentification | null; |
| "paymentMerchantReference"?: string; | ||
| /** | ||
| * Specifies the nature of the transfer. This parameter helps categorize transfers so you can reconcile transactions at a later time, using the Balance Platform Accounting Report for [marketplaces](https://docs.adyen.com/marketplaces/reports-and-fees/balance-platform-accounting-report/) or [platforms](https://docs.adyen.com/platforms/reports-and-fees/balance-platform-accounting-report/). Possible values: * **AcquiringFees**: the acquiring fee (the aggregated amount of interchange and scheme fee) incurred on a transaction. * **AdyenCommission**: the transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/guides/payments-training-guide/get-the-best-from-your-card-processing). * **AdyenFees**: all transaction fees due to Adyen. This is the aggregated amount of Adyen\'s commission and markup. * **AdyenMarkup**: the transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing). * **BalanceAccount**: the amount booked to your user after the deduction of the relevant fees. * **Commission**: your platform\'s or marketplace\'s commission on a transaction. * **DCCPlatformCommission**: the Dynamic Currency Conversion (DCC) fee on a transaction. * **Interchange**: the interchange fee (fee paid to the issuer) incurred on a transaction. * **PaymentFee**: the aggregated amount of all transaction fees. * **Remainder**: the leftover amount after currency conversion. * **SchemeFee**: the scheme fee incurred on a transaction. * **Surcharge**: the surcharge paid by the customer on a transaction. * **Tip**: the tip paid by the customer. * **TopUp**: an incoming transfer to top up your user\'s balance account. * **VAT**: the value-added tax charged on the payment. | ||
| * Specifies the nature of the transfer. This parameter helps categorize transfers so you can reconcile transactions at a later time, using the Balance Platform Accounting Report for [marketplaces](https://docs.adyen.com/marketplaces/reports-and-fees/balance-platform-accounting-report/) or [platforms](https://docs.adyen.com/platforms/reports-and-fees/balance-platform-accounting-report/). Possible values: * **AcquiringFees**: The acquiring fee (the aggregated amount of interchange and scheme fee) incurred on a transaction. * **AdyenCommission**: The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/guides/payments-training-guide/get-the-best-from-your-card-processing). * **AdyenFees**: All transaction fees due to Adyen. This is the aggregated amount of Adyen\'s commission and markup. * **AdyenMarkup**: The transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing). * **BalanceAccount**: The amount booked to your user after the deduction of the relevant fees. * **Commission**: Your platform\'s or marketplace\'s commission on a transaction. * **DCCPlatformCommission**: **deprecated** The Dynamic Currency Conversion (DCC) fee on a transaction. * **DCCMarkup**: The Dynamic Currency Conversion (DCC) fee on a transaction. * **Interchange**: The interchange fee (fee paid to the issuer) incurred on a transaction. * **PaymentFee**: The aggregated amount of all transaction fees. * **Remainder**: The leftover amount after currency conversion. * **SchemeFee**: The scheme fee incurred on a transaction. * **Surcharge**: The surcharge paid by the customer on a transaction. * **Tip**: The tip paid by the customer. * **TopUp**: An incoming transfer to top up your user\'s balance account. * **VAT**: The value-added tax charged on the payment. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To improve clarity around the deprecation, consider updating the descriptions for DCCPlatformCommission and DCCMarkup to explicitly mention the replacement relationship. This will help developers understand the change more easily.
| * Specifies the nature of the transfer. This parameter helps categorize transfers so you can reconcile transactions at a later time, using the Balance Platform Accounting Report for [marketplaces](https://docs.adyen.com/marketplaces/reports-and-fees/balance-platform-accounting-report/) or [platforms](https://docs.adyen.com/platforms/reports-and-fees/balance-platform-accounting-report/). Possible values: * **AcquiringFees**: The acquiring fee (the aggregated amount of interchange and scheme fee) incurred on a transaction. * **AdyenCommission**: The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/guides/payments-training-guide/get-the-best-from-your-card-processing). * **AdyenFees**: All transaction fees due to Adyen. This is the aggregated amount of Adyen\'s commission and markup. * **AdyenMarkup**: The transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing). * **BalanceAccount**: The amount booked to your user after the deduction of the relevant fees. * **Commission**: Your platform\'s or marketplace\'s commission on a transaction. * **DCCPlatformCommission**: **deprecated** The Dynamic Currency Conversion (DCC) fee on a transaction. * **DCCMarkup**: The Dynamic Currency Conversion (DCC) fee on a transaction. * **Interchange**: The interchange fee (fee paid to the issuer) incurred on a transaction. * **PaymentFee**: The aggregated amount of all transaction fees. * **Remainder**: The leftover amount after currency conversion. * **SchemeFee**: The scheme fee incurred on a transaction. * **Surcharge**: The surcharge paid by the customer on a transaction. * **Tip**: The tip paid by the customer. * **TopUp**: An incoming transfer to top up your user\'s balance account. * **VAT**: The value-added tax charged on the payment. | |
| * Specifies the nature of the transfer. This parameter helps categorize transfers so you can reconcile transactions at a later time, using the Balance Platform Accounting Report for [marketplaces](https://docs.adyen.com/marketplaces/reports-and-fees/balance-platform-accounting-report/) or [platforms](https://docs.adyen.com/platforms/reports-and-fees/balance-platform-accounting-report/). Possible values: * **AcquiringFees**: The acquiring fee (the aggregated amount of interchange and scheme fee) incurred on a transaction. * **AdyenCommission**: The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/guides/payments-training-guide/get-the-best-from-your-card-processing). * **AdyenFees**: All transaction fees due to Adyen. This is the aggregated amount of Adyen\'s commission and markup. * **AdyenMarkup**: The transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing). * **BalanceAccount**: The amount booked to your user after the deduction of the relevant fees. * **Commission**: Your platform\'s or marketplace\'s commission on a transaction. * **DCCPlatformCommission**: **deprecated** Use `DCCMarkup` instead. The Dynamic Currency Conversion (DCC) fee on a transaction. * **DCCMarkup**: The Dynamic Currency Conversion (DCC) fee on a transaction. Replaces the deprecated `DCCPlatformCommission`. * **Interchange**: The interchange fee (fee paid to the issuer) incurred on a transaction. * **PaymentFee**: The aggregated amount of all transaction fees. * **Remainder**: The leftover amount after currency conversion. * **SchemeFee**: The scheme fee incurred on a transaction. * **Surcharge**: The surcharge paid by the customer on a transaction. * **Tip**: The tip paid by the customer. * **TopUp**: An incoming transfer to top up your user\'s balance account. * **VAT**: The value-added tax charged on the payment. |
| * The full name of the entity that owns the bank account or card. Supported characters: [a-z] [A-Z] [0-9] , . ; : - — / \\ + & ! ? @ ( ) \" \' and space. Required when `category` is **bank**. | ||
| */ | ||
| "fullName"?: string; | ||
| "fundingInstrument"?: FundingInstrument | null; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
df4792b to
83932c3
Compare
83932c3 to
b147d85
Compare
This PR contains the automated changes for the
transfersservice.The commit history of this PR reflects the
adyen-openapicommits that have been applied.